nbiot6.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef NBIOT6_H
#define NBIOT6_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"




#define NBIOT6_CMD_AT                               "AT"
#define NBIOT6_CMD_GET_MODEL_ID                     "AT+CGMM"
#define NBIOT6_CMD_GET_MANUFACTURER_REVISION        "AT+CGMR"
#define NBIOT6_CMD_GET_SERIAL_NUM                   "AT+CGSN"
#define NBIOT6_CMD_SET_UE_FUNCTIONALITY             "AT+CFUN"
#define NBIOT6_CMD_NETWORK_REGISTRATION             "AT+CEREG"
#define NBIOT6_CMD_SIGNAL_QUALITY_REPORT            "AT+CSQ"
#define NBIOT6_CMD_OPERATOR_SELECTION               "AT+COPS"
#define NBIOT6_CMD_SEND_SMS                         "AT+CMGS"
#define NBIOT6_CMD_SELECT_SMS_FORMAT                "AT+CMGF"
#define NBIOT6_CMD_DEFINE_PDP_CONTEXT               "AT+CGDCONT"
#define NBIOT6_CMD_ACTIVATE_PDP_CONTEXT             "AT+CGACT"
#define NBIOT6_CMD_SHOW_PDP_ADDRESS                 "AT+CGPADDR"
#define NBIOT6_CMD_OPEN_SOCKET                      "AT+QIOPEN"
#define NBIOT6_CMD_CLOSE_SOCKET                     "AT+QICLOSE"
#define NBIOT6_CMD_SEND_TCP_IP_TEXT_DATA            "AT+QISEND"
#define NBIOT6_CMD_RECEIVE_TCP_IP_DATA              "AT+QIRD"
#define NBIOT6_CMD_CONFIG_NETLIGHT_LED              "AT+QLEDMODE"

#define NBIOT6_RSP_OK                               "OK"
#define NBIOT6_RSP_ERROR                            "ERROR"
#define NBIOT6_RSP_CLOSE_OK                         "CLOSE OK"

#define NBIOT6_MAX_RSP_TIME_DEFAULT                 300ul
#define NBIOT6_MAX_RSP_TIME_COPS                    630000ul
#define NBIOT6_MAX_RSP_TIME_CGACT                   150000ul
#define NBIOT6_MAX_RSP_TIME_CFUN                    90000ul
#define NBIOT6_MAX_RSP_TIME_CMGS                    30000ul
#define NBIOT6_MAX_RSP_TIME_QICLOSE                 15000ul
#define NBIOT6_MAX_RSP_TIME_URC                     15000ul

#define NBIOT6_URC_OPEN_SOCKET                      "+QIOPEN: "
#define NBIOT6_URC_RECEIVED_DATA                    "+QIURC: \"recv\""
#define NBIOT6_URC_NETWORK_REGISTERED               "+CEREG: 2,1"
#define NBIOT6_URC_SMS_FORMAT_PDU                   "+CMGF: 0"
#define NBIOT6_URC_SMS_FORMAT_TXT                   "+CMGF: 1"

#define NBIOT6_POWER_STATE_OFF                      0
#define NBIOT6_POWER_STATE_ON                       1
#define NBIOT6_POWER_STATE_RESET                    2
#define NBIOT6_POWER_STATE_WAKEUP                   3

#define NBIOT6_TX_DRV_BUFFER_SIZE                   256
#define NBIOT6_RX_DRV_BUFFER_SIZE                   256
 // nbiot6_cmd



#define NBIOT6_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.wup = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.ring = MIKROBUS( mikrobus, MIKROBUS_INT );
 // nbiot6_map // nbiot6

typedef struct
{
    // Output pins
    digital_out_t wup;              
    digital_out_t rst;              
    digital_out_t pwr;              
 
    // Input pins
    digital_in_t ring;              
 
    // Modules
    uart_t uart;                    
 
    // Buffers
    uint8_t uart_rx_buffer[ NBIOT6_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ NBIOT6_TX_DRV_BUFFER_SIZE ];  
    uint8_t cmd_buffer[ NBIOT6_TX_DRV_BUFFER_SIZE ];      
 
} nbiot6_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;              
    pin_name_t tx_pin;              
 
    // Additional gpio pins
    pin_name_t wup;                 
    pin_name_t rst;                 
    pin_name_t pwr;                 
    pin_name_t ring;                
 
    // Static variable
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
 
} nbiot6_cfg_t;

typedef enum
{
    NBIOT6_OK = 0,
    NBIOT6_ERROR = -1,
    NBIOT6_ERROR_TIMEOUT = -2,
    NBIOT6_ERROR_CMD = -3
 
} nbiot6_return_value_t;


void nbiot6_cfg_setup ( nbiot6_cfg_t *cfg );

err_t nbiot6_init ( nbiot6_t *ctx, nbiot6_cfg_t *cfg );

err_t nbiot6_generic_write ( nbiot6_t *ctx, uint8_t *data_in, uint16_t len );

err_t nbiot6_generic_read ( nbiot6_t *ctx, uint8_t *data_out, uint16_t len );

void nbiot6_set_pwr_pin ( nbiot6_t *ctx, uint8_t state );

void nbiot6_set_rst_pin ( nbiot6_t *ctx, uint8_t state );

void nbiot6_set_wup_pin ( nbiot6_t *ctx, uint8_t state );

uint8_t nbiot6_get_ring_pin ( nbiot6_t *ctx );

void nbiot6_set_power_state ( nbiot6_t *ctx, uint8_t state );

void nbiot6_cmd_run ( nbiot6_t *ctx, uint8_t *cmd );

void nbiot6_cmd_set ( nbiot6_t *ctx, uint8_t *cmd, uint8_t *value );

void nbiot6_cmd_get ( nbiot6_t *ctx, uint8_t *cmd );

void nbiot6_cmd_help ( nbiot6_t *ctx, uint8_t *cmd );

void nbiot6_set_sim_apn ( nbiot6_t *ctx, uint8_t *sim_apn );

void nbiot6_send_sms_text ( nbiot6_t *ctx, uint8_t *phone_number, uint8_t *sms_text );

err_t nbiot6_send_sms_pdu ( nbiot6_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
 
#ifdef __cplusplus
}
#endif
#endif // NBIOT6_H
 // nbiot6
 
// ------------------------------------------------------------------------ END